Recent Invoices

GET /api/v1/Invoice/RecentInvoices

Description

This endpoint is used to get a list of recent invoices. It returns a GetAllInvoicesResponseListPagedResponse object containing the list of invoices.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Query Parameters:

• InvoiceStatus: Enum, optional (values: 'New', 'Draft', 'Paid', 'Overdue')

• Counterparty: string, optional (nullable)

• AccountName: string, optional (nullable)

• RecuringInvoice: boolean, optional (nullable)

• GlobalSearch: string, optional (nullable)

• DueInvoices: boolean, optional (nullable)

Request Body:

• None

URL:

• GET: {{baseUrl API url}}/api/v1/Invoice/RecentInvoices

Response:

• A GetAllInvoicesResponseListPagedResponse object containing the list of recent invoices.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example Request URL:

GET /api/v1/Invoice/RecentInvoices

Example:

Request:

GET /api/v1/Invoice/RecentInvoices

Response:

jsonCopy codeHTTP/1.1 200 OK
{
  "invoices": [
    {
      "invoiceId": "98f2d2e5-6140-4f19-9b58-48c5003e92f7",
      "amount": 100.00,
      "currency": "USD",
      "counterparty": "John Doe",
      "status": "Paid",
      "dueDate": "2022-02-18",
      "date": "2022-01-01",
      "recurring": true
    },
    {
      "invoiceId": "585ecb04-b5cb-47ad-b0bf-38b6c1c10915",
      "amount": 200.00,
      "currency": "USD",
      "counterparty": "Jane Doe",
      "status": "Overdue",
      "dueDate": "2022-02-18",
      "date": "2022-01-01",
      "recurring": false
    }
  ],
  "totalCount": 2,
  "pageNumber": 1,
  "pageSize": 10
}

Method: GET

/api/v1/Invoice/RecentInvoices?InvoiceStatus=3&Counterparty=<string>&AccountName=<string>&RecuringInvoice=<boolean>&GlobalSearch=<string>&DueInvoices=<boolean>

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
InvoiceStatus	3
Counterparty	<string>
AccountName	<string>
RecuringInvoice	<boolean>
GlobalSearch	<string>
DueInvoices	<boolean>

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "id": "<uuid>",
      "invoiceId": "<string>",
      "counterPartyName": "<string>",
      "accountName": "<string>",
      "dueDate": "<dateTime>",
      "currency": 1,
      "discountType": 2,
      "description": "<string>",
      "billingCycle": 2,
      "recuringInvoice": "<boolean>",
      "paymentOption": 8,
      "userId": "<uuid>",
      "amount": "<double>",
      "notifications": "<string>",
      "paidAmount": "<double>",
      "created": "<dateTime>",
      "invoiceStatus": 4,
      "beforeDueDate": 4,
      "afterDueDate": 7,
      "onDueDate": "<boolean>"
    },
    {
      "id": "<uuid>",
      "invoiceId": "<string>",
      "counterPartyName": "<string>",
      "accountName": "<string>",
      "dueDate": "<dateTime>",
      "currency": 2,
      "discountType": 1,
      "description": "<string>",
      "billingCycle": 2,
      "recuringInvoice": "<boolean>",
      "paymentOption": 7,
      "userId": "<uuid>",
      "amount": "<double>",
      "notifications": "<string>",
      "paidAmount": "<double>",
      "created": "<dateTime>",
      "invoiceStatus": 4,
      "beforeDueDate": 6,
      "afterDueDate": 5,
      "onDueDate": "<boolean>"
    }
  ]
}